/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.locke.library.persistence.dao;

/**
 * @author jlocke
 */
public interface IQuery<T>
{
    /**
     * @return Number of objects matching this query
     */
    int countMatches();

    /**
     * Delete all objects matching this query
     */
    void delete();

    /**
     * @return First matching object
     */
    T firstMatch();

    /**
     * @return All matching objects
     */
    Iterable<T> matches();

    /**
     * @return All matching objects
     */
    Iterable<T> matches(int column);

    /**
     * @return Pages through matching objects with the given page size. The
     *         session may be closed at the end of each page.
     */
    Iterable<T> page(int pageSize);

    /**
     * @return Pages through matching objects with the given page size. The
     *         session may be closed at the end of each page.
     */
    Iterable<T> page(int pageSize, int column);
}
